Added ASF-required links using drop-down menu and unified navigation by zka26 · Pull Request #1198 · apache/lucenenet

zka26 · 2025-10-02T09:15:35Z

You've read the Contributor Guide and Code of Conduct.
You've included unit or integration tests for your change, where applicable.
You've included inline docs for your change, where applicable.
There's an open issue for the PR that you are making. If you'd like to propose a change, please open an issue to discuss the change or find an existing issue.

Added ASF-required links via dropdown and unified navigation.

Description

This change attempts to standardize the navbar with the newly introduced ASF menus across the Site and Apidocs and, to fix any sort of layout glitches and to improve zoom and resize and to address and solve problem that could have arisen from what was changed. DevTools were used to ensure that everything works accordingly.

General Design:

Mobile < 768
~~769 < Compact < 1199~~
(New) 768 =< Wrap < 1200
1200 <= Desktop

Desktop: Classic horizontal navigation bar extended with the ASF drop-down menu upon hover. The header is fixed when scrolling.

Mobile: Center-aligned column menu with a tap/click-to-open ASF accordion.

Compact: Transition in-between Mobile and Desktop for legacy resolutions (or maybe some tablets). It uses the hamburger menu already and the header is no longer fixed when scrolling focusing on the visibility of the content while the ‘Table of Content’ still appears as the left sidebar, and to a certain point the ‘In this Article’ appears as the right sidebar.

(New) Wrap: Reintroduced that the navbar items ( + searchbar) wraps under the logo.

Improvements:

Unified navigation: Same feel and look across the Site and Apidocs.
~~Compact mode (with new breakpoints): When the single classic horizontal navigation bar is no longer possible, we turn to the hamburger menu to prevent the header covering up too much of the content.~~
(New) Wrap mode instead of the compact mode. The buttons' heights were decreased slightly.
Ribbon safety: Keeps the hamburger menu clear of the “Fork me on GitHub” ribbon, so it is always accessible, never covered by it.
[Apidocs-Only] Search overlay: In-between 1400px and 1200px instead of the base search function, we temporarily introduce a search button to open an overlay, therefore delaying the need to switch to hamburger (or multi-line) too early, and Apidocs can switch to it at the same time as the Site.

Previews

Site:

Site - Desktop

Site - Wrap

Site - Mobile

Apidocs:

Apidocs - Desktop:

Apidocs - Wrap:

Apidocs - Mobile:

- Added Foundation, Events, License, Thanks/(Sponsors), Security, Sponsorship, Privacy (Policy) links - Inserted into _appFooter in doxfx.json - Left 2024 copyright year unchanged

NightOwl888

Thanks for the PR.

This looks good. However, note that the "website" is actually 2 websites, one generated in a subfolder of the other. They share common elements such as CSS styles and the footer.

Option 1: Include links in Footer

This only changes the site folder, but the apidocs folder also has files that contribute to the same website footer.

The two main places to update on the apidocs site are:

But we also need to keep in mind that the footer does an auto-hide, so maybe that is not the best place to put these links.

Option 2: Include links on Home Page Only

I took another look at the requirements and it specifically states that the links are only required to be on the home page. So, we could technically add a section only to that one page, in which case there is only one site to update.

Examples

Here are some examples of how some other projects integrated the links:

https://opennlp.apache.org/ - drop down from the top menu
https://activemq.apache.org/ - drop down from the top menu
https://accumulo.apache.org/ - events on the side bar, other links integrated elsewhere

Personally, I like the idea of a dropdown at the top like the first two examples. But this does meet the requirements and I don't object to anything except the fact that the footers should not diverge on the 2 websites to keep the same look and feel. So, if you fix the other footer, this works for me.

@paulirwin - Thoughts?

NOTE: I noticed that the docs always has a pancake menu. It should expand to show the 3 menu items across the top when the viewport is wide enough, so if we add a "The ASF" link in the top menu, that issue will also need to be addressed.

paulirwin · 2025-10-02T13:32:42Z

I do like the dropdown in the header, but I'm also okay with the footer for now.

The header is already wrapping on smaller resolutions, like the tablet I'm using now. If we do the header change, maybe we could move Contributing under Documentation, and Download under About (or remove Download, if possible, since most people are probably using NuGet).

But, I know this is a Hacktoberfest item, so I'm also cool with taking the quickest path to victory here.

NightOwl888 · 2025-10-02T13:40:59Z

remove Download, if possible, since most people are probably using NuGet

An Apache release is source code, so these pages are required to download the official releases. The pre-built binaries and packages are technically only provided on NuGet for convenience (at least in Apache's eyes).

https://infra.apache.org/release-publishing.html#valid

That said, IIRC there is an official .cgi file that we could style that would dynamically show the releases on Apache's archives.

paulirwin · 2025-10-02T14:44:58Z

I didn't mean to remove the page itself; just the link in the header. I don't think it needs that level of prominence.

zka26 · 2025-10-02T14:50:19Z

Thanks a lot for the detailed feedback and the examples! I would like to work on it and do it the right way, using drop-down approach in the header and try adjusting the menu layout while testing on smaller screen. I will work on that and update the PR accordingly and at the end we can see, if anything else needs to be done, more than glad to contribute! Thank you for the guidance again!

- Removed ASF links from _appFooter and preparing to move ASF links into the top navigation menu using dropdown.

- Added ASF Foundation, Events, License, Thanks, Security, Sponsorship, and Privacy Policy links to the apidocs/site menu. CSS and JS updates for the dropdown are still required.

…apidocs) - styles/custom.js included in head.tmpl.partial + head-content.tmpl.partial - main.css,custom.js: - ASF dropdown style (hover on dekstop, tap on mobile) with caret. - Attempts to make navbar stable across resize, zoom. (apidocs navbar will be addressed by the next commit)

NightOwl888 · 2025-10-06T05:52:49Z

@zka26 - I noticed this is still marked as a draft PR. Do you have more work to do or is this ready for review?

Note that the EditorConfig checker also caught some issues with extra trailing whitespace.

zka26 · 2025-10-08T00:10:25Z

@NightOwl888 - Sorry for the late reply and thanks for checking in! The work is nearly complete. I've extended the navbars with the ASF dropdown menu, adding links for both the main site and the apidocs, and have worked to make them look and behave uniformly in both the pancake and desktop modes.

I'm just putting on the final touches now, fixing a small issue in the apidocs part and reverting some changes in the site part to ensure they look and feel more alike.

Thanks for the heads-up about the trailing whitespaces—I've eliminated them.

I plan to commit the finalized version, edit the PR description, and set it for review in about 10 hours.

Edit: Sorry! The 10 hours became much more hours. I reworked the site and almost the apidocs is ready too. I will do my best to submit it today (10.10 Friday)

…te (not apidocs)" This reverts commit 3d8b026.

- Desktop: hover dropdown; Mobile: accordion in hamburger - Carets and unified drop-down menu - Sticky header on desktop; scroll-away on mobile/compact - GitHub Fork Me ribbon safety margin - Added main.js and registered in head-content.tmpl.partial and head.tmpl.partial

- Desktop: hover dropdown; Mobile: accordion in hamburger - Carets and submenu unification - Sticky header on desktop; scorll-away on mobile, compact - GitHub Fork Me safety spacing - Replaced inline search with "Search..." trigger at 1200-1399px - It does not include the auto-updated docfx.global.json and docfx.global.subsite.json and any other auto-updated files.

zka26 · 2025-10-21T22:56:22Z

Sorry, this took longer than expected. The learning curve was trickier than I thought and I decided to restart a few times. I added the ASF-required links via dropdown and unified the navs. I significantly reworked the main.css and main.js files (added main.js for the Site). I tested across viewports/zoom in DevTools to address issues. On the Apidocs, there is a compact search overlay between 1200-1399px to keep a single-line navbar and match the Site. I hope the result feels clean and consistent.
If anything should be reverted, adjusted, included or excluded, please let me know!
I am happy to improve it and take your recommendation.

Edit: Please take all the time you need on the review. Hacktoberfest isn’t a deadline for me.

…Checker for the .js files.

NightOwl888

Thanks. This looks really good. I checked both the website and docs site and they now look more uniform than they did before.

My only minor quibble is that the top menu used to wrap under the logo when the viewport got too small so it didn't collapse to a pancake until it got to the smallest width. Now it switches to a pancake menu when it goes below the maximum viewport size.

Before

Now

Can you fix that so it will wrap again?

- Reintroduced wrap, when the the navbar no longer fits into one line - CSS: Tried to clean it up by consolidating rules and made some changes due to how it reacted the wrapped navbar - JS: Now using matchMedia to detect and get the correct CSS mode and made some changes due to how it reacted the wrapped navbar

zka26 · 2025-10-31T02:19:02Z

The wrapping was restored and tried to fine tune the behaviors so they always respond good and clean at every width before transitioning either to the Desktop or the Mobile mode.

Edit: Updated the PR description accordingly and included new screenshots with the wrapping as well.

NightOwl888

Thanks. This looks really good.

…1198) * Added ASF-required footer links in doxfx.json - Added Foundation, Events, License, Thanks/(Sponsors), Security, Sponsorship, Privacy (Policy) links - Inserted into _appFooter in doxfx.json - Left 2024 copyright year unchanged * Revert footer changes in doxfx.json - Removed ASF links from _appFooter and preparing to move ASF links into the top navigation menu using dropdown. * Updated toc.yml with ASF menu entries - Added ASF Foundation, Events, License, Thanks, Security, Sponsorship, and Privacy Policy links to the apidocs/site menu. CSS and JS updates for the dropdown are still required. * Added ASF links to navigation and dropdown behavior to the site (not apidocs) - styles/custom.js included in head.tmpl.partial + head-content.tmpl.partial - main.css,custom.js: - ASF dropdown style (hover on dekstop, tap on mobile) with caret. - Attempts to make navbar stable across resize, zoom. (apidocs navbar will be addressed by the next commit) * Revert "Added ASF links to navigation and dropdown behavior to the site (not apidocs)" This reverts commit 3d8b026. * Added ASF dropdown & unify nav; introduce main.js (Site) - Desktop: hover dropdown; Mobile: accordion in hamburger - Carets and unified drop-down menu - Sticky header on desktop; scroll-away on mobile/compact - GitHub Fork Me ribbon safety margin - Added main.js and registered in head-content.tmpl.partial and head.tmpl.partial * Added ASF dropdown & unified nav; compact search overlay (Apidocs) - Desktop: hover dropdown; Mobile: accordion in hamburger - Carets and submenu unification - Sticky header on desktop; scorll-away on mobile, compact - GitHub Fork Me safety spacing - Replaced inline search with "Search..." trigger at 1200-1399px - It does not include the auto-updated docfx.global.json and docfx.global.subsite.json and any other auto-updated files. * Fixed the wrong indent style (tabs) error marked by the EditorConfig Checker for the .js files. * Restore wrap and rework CSS and JS for Apidocs - Reintroduced wrap, when the the navbar no longer fits into one line - CSS: Tried to clean it up by consolidating rules and made some changes due to how it reacted the wrapped navbar - JS: Now using matchMedia to detect and get the correct CSS mode and made some changes due to how it reacted the wrapped navbar * Restore wrap and rework CSS and JS for Site - Reintroduced wrap, when the the navbar no longer fits into one line - CSS: Tried to clean it up by consolidating rules and made some changes due to how it reacted the wrapped navbar - JS: Now using matchMedia to detect and get the correct CSS mode and made some changes due to how it reacted the wrapped navbar

Updated [Lucene.Net](https://github.com/apache/lucenenet) from 4.8.0-beta00017 to 4.8.0-beta00018. <details> <summary>Release notes</summary> _Sourced from [Lucene.Net's releases](https://github.com/apache/lucenenet/releases)._ ## 4.8.0-beta00018 > This is a maintenance update that upgrades ICU4N to the latest version, since several serious concurrency and resource loading bugs have been patched since the last Lucene.NET release.  ## What's Changed ### 🐞 Bug Fixes * FuzzyQuery produces a wrong result when prefix is equal to the term length by @paulirwin in apache/lucenenet#1002 * Validate PatternParser DTDs against expected name by @paulirwin in apache/lucenenet#1358 * Validate file paths for FSDirectory and Replicator by @paulirwin in apache/lucenenet#1357 * Bumped ICU4N to 60.1.0-alpha.440 by @NightOwl888 in apache/lucenenet#1353 * ShingleFilter produces invalid queries by @tohidemyname in apache/lucenenet#946 * Fix SegmentInfos replace doesn't update userData by @tohidemyname in apache/lucenenet#948 ### 🚀 Performance Improvements * SWEEP: Replace J2N's TripleShift call with C# 11's unsigned right shift operator by @paulirwin in apache/lucenenet#1007 ### 🏆 Improvements * Added "Improvements" Category for Release Notes by @NightOwl888 in apache/lucenenet#1015 ### 📄 Website and API Documentation * website/site/.htaccess - bug fix by removing BOM and update to beta0017 redirection by @rclabo in apache/lucenenet#1005 * Updated .htaccess copy and release procedure by @NightOwl888 in apache/lucenenet#1010 * Added GitHub Automation for Release Notes by @NightOwl888 in apache/lucenenet#1011 * fix: Render ASF policy links in static HTML footer by @rbowen in apache/lucenenet#1303 * Fix/apidocs breadcrumb toc asf by @zka26 in apache/lucenenet#1232 * README: fix typo MacOS -> macOS by @jbampton in apache/lucenenet#1179 * Added ASF-required links using drop-down menu and unified navigation by @zka26 in apache/lucenenet#1198 * fix: Self-host all external website dependencies by @mmafrar in apache/lucenenet#1197 * Fix typos by @jbampton in apache/lucenenet#1177 * Replace lucene.testSettings.config references with lucene.testsettings.json by @paulirwin in apache/lucenenet#1035 ## New Contributors * @jbampton made their first contribution in apache/lucenenet#1177 * @mmafrar made their first contribution in apache/lucenenet#1197 * @rbowen made their first contribution in apache/lucenenet#1303 * @tohidemyname made their first contribution in apache/lucenenet#946 * @zka26 made their first contribution in apache/lucenenet#1198 **Full Changelog**: apache/lucenenet@Lucene.Net_4_8_0_beta00017...Lucene.Net_4_8_0_beta00018 Commits viewable in [compare view](apache/lucenenet@Lucene.Net_4_8_0_beta00017...Lucene.Net_4_8_0_beta00018). </details> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=Lucene.Net&package-manager=nuget&previous-version=4.8.0-beta00017&new-version=4.8.0-beta00018)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…639) Updated [Lucene.Net.QueryParser](https://github.com/apache/lucenenet) from 4.8.0-beta00017 to 4.8.0-beta00018. <details> <summary>Release notes</summary> _Sourced from [Lucene.Net.QueryParser's releases](https://github.com/apache/lucenenet/releases)._ ## 4.8.0-beta00018 > This is a maintenance update that upgrades ICU4N to the latest version, since several serious concurrency and resource loading bugs have been patched since the last Lucene.NET release.  ## What's Changed ### 🐞 Bug Fixes * FuzzyQuery produces a wrong result when prefix is equal to the term length by @paulirwin in apache/lucenenet#1002 * Validate PatternParser DTDs against expected name by @paulirwin in apache/lucenenet#1358 * Validate file paths for FSDirectory and Replicator by @paulirwin in apache/lucenenet#1357 * Bumped ICU4N to 60.1.0-alpha.440 by @NightOwl888 in apache/lucenenet#1353 * ShingleFilter produces invalid queries by @tohidemyname in apache/lucenenet#946 * Fix SegmentInfos replace doesn't update userData by @tohidemyname in apache/lucenenet#948 ### 🚀 Performance Improvements * SWEEP: Replace J2N's TripleShift call with C# 11's unsigned right shift operator by @paulirwin in apache/lucenenet#1007 ### 🏆 Improvements * Added "Improvements" Category for Release Notes by @NightOwl888 in apache/lucenenet#1015 ### 📄 Website and API Documentation * website/site/.htaccess - bug fix by removing BOM and update to beta0017 redirection by @rclabo in apache/lucenenet#1005 * Updated .htaccess copy and release procedure by @NightOwl888 in apache/lucenenet#1010 * Added GitHub Automation for Release Notes by @NightOwl888 in apache/lucenenet#1011 * fix: Render ASF policy links in static HTML footer by @rbowen in apache/lucenenet#1303 * Fix/apidocs breadcrumb toc asf by @zka26 in apache/lucenenet#1232 * README: fix typo MacOS -> macOS by @jbampton in apache/lucenenet#1179 * Added ASF-required links using drop-down menu and unified navigation by @zka26 in apache/lucenenet#1198 * fix: Self-host all external website dependencies by @mmafrar in apache/lucenenet#1197 * Fix typos by @jbampton in apache/lucenenet#1177 * Replace lucene.testSettings.config references with lucene.testsettings.json by @paulirwin in apache/lucenenet#1035 ## New Contributors * @jbampton made their first contribution in apache/lucenenet#1177 * @mmafrar made their first contribution in apache/lucenenet#1197 * @rbowen made their first contribution in apache/lucenenet#1303 * @tohidemyname made their first contribution in apache/lucenenet#946 * @zka26 made their first contribution in apache/lucenenet#1198 **Full Changelog**: apache/lucenenet@Lucene.Net_4_8_0_beta00017...Lucene.Net_4_8_0_beta00018 Commits viewable in [compare view](apache/lucenenet@Lucene.Net_4_8_0_beta00017...Lucene.Net_4_8_0_beta00018). </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Added ASF-required footer links in doxfx.json

03b7a7d

- Added Foundation, Events, License, Thanks/(Sponsors), Security, Sponsorship, Privacy (Policy) links - Inserted into _appFooter in doxfx.json - Left 2024 copyright year unchanged

NightOwl888 added the notes:website-or-documentation Documentation or website changes label Oct 2, 2025

NightOwl888 requested changes Oct 2, 2025

View reviewed changes

NightOwl888 added the hacktoberfest-accepted PR is approved for Hacktoberfest even if not merged label Oct 2, 2025

Revert footer changes in doxfx.json

0706259

- Removed ASF links from _appFooter and preparing to move ASF links into the top navigation menu using dropdown.

zka26 marked this pull request as draft October 2, 2025 19:11

zka26 added 2 commits October 3, 2025 19:27

Updated toc.yml with ASF menu entries

8fdd6d0

- Added ASF Foundation, Events, License, Thanks, Security, Sponsorship, and Privacy Policy links to the apidocs/site menu. CSS and JS updates for the dropdown are still required.

zka26 added 3 commits October 13, 2025 02:06

Revert "Added ASF links to navigation and dropdown behavior to the si…

8c45df3

…te (not apidocs)" This reverts commit 3d8b026.

zka26 marked this pull request as ready for review October 21, 2025 22:56

zka26 requested a review from NightOwl888 October 21, 2025 22:57

Fixed the wrong indent style (tabs) error marked by the EditorConfig …

71b14d9

…Checker for the .js files.

zka26 changed the title ~~Added ASF-required footer links in doxfx.json~~ Added ASF-required links using drop-down menu and unified navigation Oct 23, 2025

NightOwl888 requested changes Oct 26, 2025

View reviewed changes

zka26 added 2 commits October 31, 2025 03:08

zka26 requested a review from NightOwl888 October 31, 2025 02:20

NightOwl888 approved these changes Oct 31, 2025

View reviewed changes

NightOwl888 merged commit 2991483 into apache:master Oct 31, 2025
1 check passed

This was referenced Jul 19, 2026

Bump the nuget-minor-and-patch group with 28 updates linkuity/linkuity#5

Closed

Bump Aspire.Hosting.Azure.ServiceBus and 22 others linkuity/linkuity#16

Closed

Bump Aspire.Hosting.Azure.Storage and 18 others linkuity/linkuity#30

Closed

dependabot Bot mentioned this pull request Aug 9, 2026

Bump the nuget-minor-and-patch group with 19 updates linkuity/linkuity#59

Closed

This was referenced Aug 16, 2026

Bump the nuget-minor-and-patch group with 27 updates linkuity/linkuity#80

Closed

Bump Aspire.Hosting.Azure.Storage and 18 others linkuity/linkuity#81

Closed

Bump Aspire.Hosting.Azure.Storage and 26 others linkuity/linkuity#88

Open

Navigation Menu

Uh oh!

Added ASF-required links using drop-down menu and unified navigation - #1198

Added ASF-required links using drop-down menu and unified navigation#1198
NightOwl888 merged 10 commits into
apache:masterfrom
zka26:docs/footer-asf-required-links

zka26 commented Oct 2, 2025 •

edited

Loading

Uh oh!

NightOwl888 left a comment •

edited

Loading

Uh oh!

paulirwin commented Oct 2, 2025

Uh oh!

NightOwl888 commented Oct 2, 2025

Uh oh!

paulirwin commented Oct 2, 2025

Uh oh!

zka26 commented Oct 2, 2025

Uh oh!

NightOwl888 commented Oct 6, 2025

Uh oh!

zka26 commented Oct 8, 2025 •

edited

Loading

Uh oh!

zka26 commented Oct 21, 2025 •

edited

Loading

Uh oh!

NightOwl888 left a comment

Uh oh!

zka26 commented Oct 31, 2025 •

edited

Loading

Uh oh!

NightOwl888 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

zka26 commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

General Design:

Improvements:

Previews

Site:

Apidocs:

Uh oh!

NightOwl888 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Option 1: Include links in Footer

Option 2: Include links on Home Page Only

Examples

Uh oh!

paulirwin commented Oct 2, 2025

Uh oh!

NightOwl888 commented Oct 2, 2025

Uh oh!

paulirwin commented Oct 2, 2025

Uh oh!

zka26 commented Oct 2, 2025

Uh oh!

NightOwl888 commented Oct 6, 2025

Uh oh!

zka26 commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zka26 commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NightOwl888 left a comment

Choose a reason for hiding this comment

Before

Now

Uh oh!

zka26 commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NightOwl888 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zka26 commented Oct 2, 2025 •

edited

Loading

NightOwl888 left a comment •

edited

Loading

zka26 commented Oct 8, 2025 •

edited

Loading

zka26 commented Oct 21, 2025 •

edited

Loading

zka26 commented Oct 31, 2025 •

edited

Loading